Skip to main content
POST
/
v1
/
inventory
/
warehouses
/
{id}
/
locations
Create Location
curl --request POST \
  --url https://{base_url_domain}/api/global/v1/inventory/warehouses/{id}/locations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "A4-55-C3",
  "priority": 10,
  "is_type_auto": true,
  "lot": {
    "type": "Lot",
    "id": 54
  },
  "product": {
    "type": "Product",
    "id": 123
  },
  "rack": {
    "type": "Rack",
    "id": 123
  },
  "location_type": {
    "type": "LocationType",
    "id": 54
  }
}
'
{
  "resource": {
    "type": "<string>",
    "id": 1
  },
  "meta": {
    "processing_time": 123
  }
}

Authorizations

​
Authorization
string
header
required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Path Parameters

​
id
integer<int32>
required

The id of the referenced Warehouse.

Body

application/json

An object conforming to the Inventory Warehouse Location schema to be created.

A Location describes a user-specified inventory address within a warehouse.

​
label
string | null

The human-readable name of a location and also the value encoded in location's barcode label. This value must be unique within each warehouse.

Example:

"A4-55-C3"

​
priority
integer

The inventory reservation order relative to other locations containing the same product.

Example:

10

​
is_type_auto
boolean | null

If Location Type is "Automatic" then it will cause the type to be maintained automatically according to the Auto-Assign Patterns of the location types.
Optional Field

Example:

true

​
lot
LotRef · object

A reference to the Lot object assigned to this location.

​
product
StockableProductRef · object

A reference to the stockable product assigned to this location.

​
rack
RackRef · object

A reference to the Rack to which this location is assigned. This may be managed automatically or assigned manually.

​
location_type
LocationTypeRef · object

A reference to the LocationType object assigned to this location. This may be managed automatically or assigned manually.

Response

Created - The resource was created successfully.

​
resource
object

An object describing the resource that was created.

​
meta
object